Skip to main content

Get Shipment Metrics

GET /tms/shipments/metrics

Description​

This endpoint retrieves shipment metrics for a specified tenant and country. It provides data related to the performance and status of shipments.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code for which the shipment metrics are requested.

Responses​

  • 200 OK

    • Media type: Controls Accept header.

    • Example Value:

      {
        "status": true,
        "statusCode": 0,
        "message": "string",
        "data": {},
        "errors": [
          {
            "message": "string",
            "descriptiveMessage": "string"
          }
        ]
      }

  • 400 Bad Request

    • Description: Shipment not found.

  • 404 Not Found

    • Description: Shipment not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/shipments/metrics \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!